<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    // Copyright 2006-08 Regents of the University of California.  May be used <a name="line.1"></a>
<FONT color="green">002</FONT>    // under the terms of the revised BSD license.  See LICENSING for details.<a name="line.2"></a>
<FONT color="green">003</FONT>    /** <a name="line.3"></a>
<FONT color="green">004</FONT>     * @author Adrian Mettler <a name="line.4"></a>
<FONT color="green">005</FONT>     */<a name="line.5"></a>
<FONT color="green">006</FONT>    package org.joe_e.array;<a name="line.6"></a>
<FONT color="green">007</FONT>    <a name="line.7"></a>
<FONT color="green">008</FONT>    import org.joe_e.JoeE;<a name="line.8"></a>
<FONT color="green">009</FONT>    import org.joe_e.Powerless;<a name="line.9"></a>
<FONT color="green">010</FONT>    import org.joe_e.reflect.Reflection;<a name="line.10"></a>
<FONT color="green">011</FONT>    <a name="line.11"></a>
<FONT color="green">012</FONT>    /**<a name="line.12"></a>
<FONT color="green">013</FONT>     * An immutable array containing powerless objects.<a name="line.13"></a>
<FONT color="green">014</FONT>     * <a name="line.14"></a>
<FONT color="green">015</FONT>     * @param &lt;E&gt; the element type of objects contained in the array<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    public class PowerlessArray&lt;E&gt; extends ImmutableArray&lt;E&gt; implements Powerless {<a name="line.17"></a>
<FONT color="green">018</FONT>        static private final long serialVersionUID = 1L;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>        /**<a name="line.20"></a>
<FONT color="green">021</FONT>         * Package-scope back-door constructor for use by subclasses that<a name="line.21"></a>
<FONT color="green">022</FONT>         * override all methods that make use of the field arr.  Nullity of arr is<a name="line.22"></a>
<FONT color="green">023</FONT>         * used to distinguish between instances with which this class must interact<a name="line.23"></a>
<FONT color="green">024</FONT>         * by using the public interface rather than through their arr field.<a name="line.24"></a>
<FONT color="green">025</FONT>         */<a name="line.25"></a>
<FONT color="green">026</FONT>            PowerlessArray(final Object[] arr) {<a name="line.26"></a>
<FONT color="green">027</FONT>                    super(arr); <a name="line.27"></a>
<FONT color="green">028</FONT>            }<a name="line.28"></a>
<FONT color="green">029</FONT>        <a name="line.29"></a>
<FONT color="green">030</FONT>        /**<a name="line.30"></a>
<FONT color="green">031</FONT>         * Construct a &lt;code&gt;PowerlessArray&lt;/code&gt;.  The type will be <a name="line.31"></a>
<FONT color="green">032</FONT>         * @param values    each value, or an array of values<a name="line.32"></a>
<FONT color="green">033</FONT>         * @throws ClassCastException if the runtime component type of <a name="line.33"></a>
<FONT color="green">034</FONT>         *     &lt;code&gt;values&lt;/code&gt; is not powerless in the overlay type system<a name="line.34"></a>
<FONT color="green">035</FONT>         */<a name="line.35"></a>
<FONT color="green">036</FONT>        static public &lt;T&gt; PowerlessArray&lt;T&gt; array(final T... values) {<a name="line.36"></a>
<FONT color="green">037</FONT>            final Class&lt;?&gt; e = values.getClass().getComponentType();<a name="line.37"></a>
<FONT color="green">038</FONT>            if (!JoeE.isSubtypeOf(e, Powerless.class)) {<a name="line.38"></a>
<FONT color="green">039</FONT>                throw new ClassCastException(Reflection.getName(e) + <a name="line.39"></a>
<FONT color="green">040</FONT>                                             " is not Powerless");<a name="line.40"></a>
<FONT color="green">041</FONT>            }<a name="line.41"></a>
<FONT color="green">042</FONT>            return new PowerlessArray&lt;T&gt;(values.clone());<a name="line.42"></a>
<FONT color="green">043</FONT>        }<a name="line.43"></a>
<FONT color="green">044</FONT>        <a name="line.44"></a>
<FONT color="green">045</FONT>        /* <a name="line.45"></a>
<FONT color="green">046</FONT>         * See the comment in ConstArray for why the following methods exist.<a name="line.46"></a>
<FONT color="green">047</FONT>         */<a name="line.47"></a>
<FONT color="green">048</FONT>    <a name="line.48"></a>
<FONT color="green">049</FONT>        /**<a name="line.49"></a>
<FONT color="green">050</FONT>         * Construct an empty &lt;code&gt;ConstArray&lt;/code&gt;.<a name="line.50"></a>
<FONT color="green">051</FONT>         */<a name="line.51"></a>
<FONT color="green">052</FONT>        static public &lt;T&gt; PowerlessArray&lt;T&gt; array() {<a name="line.52"></a>
<FONT color="green">053</FONT>            return new PowerlessArray&lt;T&gt;(new Object[]{});<a name="line.53"></a>
<FONT color="green">054</FONT>        }  <a name="line.54"></a>
<FONT color="green">055</FONT>        <a name="line.55"></a>
<FONT color="green">056</FONT>        /**<a name="line.56"></a>
<FONT color="green">057</FONT>         * Check an array to see that all elements are immutable; if so wraps<a name="line.57"></a>
<FONT color="green">058</FONT>         * it WITHOUT a defensive copy<a name="line.58"></a>
<FONT color="green">059</FONT>         */<a name="line.59"></a>
<FONT color="green">060</FONT>        static private &lt;T&gt; PowerlessArray&lt;T&gt; array2(final Object... values) {<a name="line.60"></a>
<FONT color="green">061</FONT>            for (Object v: values) {<a name="line.61"></a>
<FONT color="green">062</FONT>                Class&lt;?&gt; vType = v.getClass();<a name="line.62"></a>
<FONT color="green">063</FONT>                if (!JoeE.isSubtypeOf(vType, Powerless.class)) {<a name="line.63"></a>
<FONT color="green">064</FONT>                    throw new ClassCastException(Reflection.getName(vType) +<a name="line.64"></a>
<FONT color="green">065</FONT>                                                 " is not Powerless");<a name="line.65"></a>
<FONT color="green">066</FONT>                }<a name="line.66"></a>
<FONT color="green">067</FONT>            }<a name="line.67"></a>
<FONT color="green">068</FONT>            return new PowerlessArray&lt;T&gt;(values);<a name="line.68"></a>
<FONT color="green">069</FONT>        }<a name="line.69"></a>
<FONT color="green">070</FONT>    <a name="line.70"></a>
<FONT color="green">071</FONT>        /**<a name="line.71"></a>
<FONT color="green">072</FONT>         * Construct a &lt;code&gt;ConstArray&lt;/code&gt; with one element.<a name="line.72"></a>
<FONT color="green">073</FONT>         * @param value    the value<a name="line.73"></a>
<FONT color="green">074</FONT>         */<a name="line.74"></a>
<FONT color="green">075</FONT>        static public &lt;T&gt; PowerlessArray&lt;T&gt; array(final T value) {<a name="line.75"></a>
<FONT color="green">076</FONT>            return array2(value);<a name="line.76"></a>
<FONT color="green">077</FONT>        }<a name="line.77"></a>
<FONT color="green">078</FONT>    <a name="line.78"></a>
<FONT color="green">079</FONT>        /**<a name="line.79"></a>
<FONT color="green">080</FONT>         * Construct a &lt;code&gt;ConstArray&lt;/code&gt; with two elements.<a name="line.80"></a>
<FONT color="green">081</FONT>         * @param value1    the first value<a name="line.81"></a>
<FONT color="green">082</FONT>         * @param value2    the second value<a name="line.82"></a>
<FONT color="green">083</FONT>         */<a name="line.83"></a>
<FONT color="green">084</FONT>        static public &lt;T&gt; PowerlessArray&lt;T&gt; array(final T value1, final T value2) {<a name="line.84"></a>
<FONT color="green">085</FONT>            return array2(value1, value2);<a name="line.85"></a>
<FONT color="green">086</FONT>        }<a name="line.86"></a>
<FONT color="green">087</FONT>    <a name="line.87"></a>
<FONT color="green">088</FONT>        /**<a name="line.88"></a>
<FONT color="green">089</FONT>         * Construct an &lt;code&gt;PowerlessArray&lt;/code&gt; with three elements.<a name="line.89"></a>
<FONT color="green">090</FONT>         * @param value1    the first value<a name="line.90"></a>
<FONT color="green">091</FONT>         * @param value2    the second value<a name="line.91"></a>
<FONT color="green">092</FONT>         * @param value3    the third value<a name="line.92"></a>
<FONT color="green">093</FONT>         */<a name="line.93"></a>
<FONT color="green">094</FONT>        static public &lt;T&gt; PowerlessArray&lt;T&gt; array(final T value1, final T value2, <a name="line.94"></a>
<FONT color="green">095</FONT>                                              final T value3) {<a name="line.95"></a>
<FONT color="green">096</FONT>            return array2(value1, value2, value3);<a name="line.96"></a>
<FONT color="green">097</FONT>        }<a name="line.97"></a>
<FONT color="green">098</FONT>    <a name="line.98"></a>
<FONT color="green">099</FONT>        /**<a name="line.99"></a>
<FONT color="green">100</FONT>         * Construct an &lt;code&gt;PowerlessArray&lt;/code&gt; with four elements.<a name="line.100"></a>
<FONT color="green">101</FONT>         * @param value1    the first value<a name="line.101"></a>
<FONT color="green">102</FONT>         * @param value2    the second value<a name="line.102"></a>
<FONT color="green">103</FONT>         * @param value3    the third value<a name="line.103"></a>
<FONT color="green">104</FONT>         * @param value4    the fourth value<a name="line.104"></a>
<FONT color="green">105</FONT>         */<a name="line.105"></a>
<FONT color="green">106</FONT>        static public &lt;T&gt; PowerlessArray&lt;T&gt; array(final T value1, final T value2, <a name="line.106"></a>
<FONT color="green">107</FONT>                                              final T value3, final T value4) {<a name="line.107"></a>
<FONT color="green">108</FONT>            return array2(value1, value2, value3, value4);<a name="line.108"></a>
<FONT color="green">109</FONT>        }       <a name="line.109"></a>
<FONT color="green">110</FONT>        <a name="line.110"></a>
<FONT color="green">111</FONT>        /**<a name="line.111"></a>
<FONT color="green">112</FONT>         * Return a new &lt;code&gt;PowerlessArray&lt;/code&gt; that contains the same elements<a name="line.112"></a>
<FONT color="green">113</FONT>         * as this one but with a new element added to the end.<a name="line.113"></a>
<FONT color="green">114</FONT>         * @param newE an element to add<a name="line.114"></a>
<FONT color="green">115</FONT>         * @return the new array<a name="line.115"></a>
<FONT color="green">116</FONT>         * @throws ClassCastException if &lt;code&gt;newE&lt;/code&gt; is not powerless <a name="line.116"></a>
<FONT color="green">117</FONT>         */<a name="line.117"></a>
<FONT color="green">118</FONT>        public PowerlessArray&lt;E&gt; with(E newE) {<a name="line.118"></a>
<FONT color="green">119</FONT>            if (!JoeE.instanceOf(newE, Powerless.class)) {<a name="line.119"></a>
<FONT color="green">120</FONT>                throw new ClassCastException(Reflection.getName(newE.getClass()) +<a name="line.120"></a>
<FONT color="green">121</FONT>                                             "is not Powerless");<a name="line.121"></a>
<FONT color="green">122</FONT>            }<a name="line.122"></a>
<FONT color="green">123</FONT>            // We use a new Object array here, because we don't know the static type<a name="line.123"></a>
<FONT color="green">124</FONT>            // of E that was used; it may not match the dynamic component type of<a name="line.124"></a>
<FONT color="green">125</FONT>            // arr due to array covariance.<a name="line.125"></a>
<FONT color="green">126</FONT>            final Object[] newArr = new Object[arr.length + 1];<a name="line.126"></a>
<FONT color="green">127</FONT>            System.arraycopy(arr, 0, newArr, 0, arr.length);<a name="line.127"></a>
<FONT color="green">128</FONT>            newArr[arr.length] = newE;<a name="line.128"></a>
<FONT color="green">129</FONT>            return new PowerlessArray&lt;E&gt;(newArr);<a name="line.129"></a>
<FONT color="green">130</FONT>        }<a name="line.130"></a>
<FONT color="green">131</FONT>        <a name="line.131"></a>
<FONT color="green">132</FONT>        /**<a name="line.132"></a>
<FONT color="green">133</FONT>         * Return a new &lt;code&gt;PowerlessArray&lt;/code&gt; that contains the same elements<a name="line.133"></a>
<FONT color="green">134</FONT>         * as this one excluding the element at a specified index<a name="line.134"></a>
<FONT color="green">135</FONT>         * @param i the index of the element to exclude<a name="line.135"></a>
<FONT color="green">136</FONT>         * @return  the new array<a name="line.136"></a>
<FONT color="green">137</FONT>         */<a name="line.137"></a>
<FONT color="green">138</FONT>        public PowerlessArray&lt;E&gt; without(final int i) {<a name="line.138"></a>
<FONT color="green">139</FONT>            final Object[] newArr = new Object[arr.length - 1];<a name="line.139"></a>
<FONT color="green">140</FONT>            System.arraycopy(arr, 0, newArr, 0, i);<a name="line.140"></a>
<FONT color="green">141</FONT>            System.arraycopy(arr, i + 1, newArr, i, newArr.length - i);<a name="line.141"></a>
<FONT color="green">142</FONT>            return new PowerlessArray&lt;E&gt;(newArr);<a name="line.142"></a>
<FONT color="green">143</FONT>        }<a name="line.143"></a>
<FONT color="green">144</FONT>        <a name="line.144"></a>
<FONT color="green">145</FONT>        /**<a name="line.145"></a>
<FONT color="green">146</FONT>         * A {@link PowerlessArray} factory.<a name="line.146"></a>
<FONT color="green">147</FONT>         */<a name="line.147"></a>
<FONT color="green">148</FONT>        public static class Builder&lt;E&gt; extends ImmutableArray.Builder&lt;E&gt; {<a name="line.148"></a>
<FONT color="green">149</FONT>            /**<a name="line.149"></a>
<FONT color="green">150</FONT>             * Construct an instance with the default internal array length.<a name="line.150"></a>
<FONT color="green">151</FONT>             */<a name="line.151"></a>
<FONT color="green">152</FONT>            Builder() {<a name="line.152"></a>
<FONT color="green">153</FONT>                super();<a name="line.153"></a>
<FONT color="green">154</FONT>            }<a name="line.154"></a>
<FONT color="green">155</FONT>            <a name="line.155"></a>
<FONT color="green">156</FONT>            /**<a name="line.156"></a>
<FONT color="green">157</FONT>             * Construct an instance.<a name="line.157"></a>
<FONT color="green">158</FONT>             * @param estimate  estimated array length<a name="line.158"></a>
<FONT color="green">159</FONT>             */<a name="line.159"></a>
<FONT color="green">160</FONT>            Builder(int estimate) {<a name="line.160"></a>
<FONT color="green">161</FONT>                super(estimate);<a name="line.161"></a>
<FONT color="green">162</FONT>            }        <a name="line.162"></a>
<FONT color="green">163</FONT>    <a name="line.163"></a>
<FONT color="green">164</FONT>            /** <a name="line.164"></a>
<FONT color="green">165</FONT>             * Appends an element to the Array<a name="line.165"></a>
<FONT color="green">166</FONT>             * @param newE the element to append<a name="line.166"></a>
<FONT color="green">167</FONT>             * @throws ClassCastException if the &lt;code&gt;newE&lt;/code&gt; is not powerless<a name="line.167"></a>
<FONT color="green">168</FONT>             * @throws NegativeArraySizeException if the resulting internal array<a name="line.168"></a>
<FONT color="green">169</FONT>             *  would exceed the maximum length of a Java array.  The builder is<a name="line.169"></a>
<FONT color="green">170</FONT>             *  unmodified.<a name="line.170"></a>
<FONT color="green">171</FONT>             */<a name="line.171"></a>
<FONT color="green">172</FONT>             public void append(E newE) {<a name="line.172"></a>
<FONT color="green">173</FONT>                if (!JoeE.instanceOf(newE, Powerless.class)) {<a name="line.173"></a>
<FONT color="green">174</FONT>                    throw new ClassCastException(Reflection.getName(newE.getClass())<a name="line.174"></a>
<FONT color="green">175</FONT>                                                 + "is not Powerless");<a name="line.175"></a>
<FONT color="green">176</FONT>                }<a name="line.176"></a>
<FONT color="green">177</FONT>                <a name="line.177"></a>
<FONT color="green">178</FONT>                appendInternal(newE);<a name="line.178"></a>
<FONT color="green">179</FONT>            }<a name="line.179"></a>
<FONT color="green">180</FONT>    <a name="line.180"></a>
<FONT color="green">181</FONT>            /** <a name="line.181"></a>
<FONT color="green">182</FONT>             * Appends all elements from a Java array to the Array<a name="line.182"></a>
<FONT color="green">183</FONT>             * @param newEs the element to append<a name="line.183"></a>
<FONT color="green">184</FONT>             * @throws ClassCastException if the &lt;code&gt;newEs&lt;/code&gt; are not<a name="line.184"></a>
<FONT color="green">185</FONT>             *  powerless<a name="line.185"></a>
<FONT color="green">186</FONT>             * @throws IndexOutOfBoundsException if the resulting internal array<a name="line.186"></a>
<FONT color="green">187</FONT>             *  would exceed the maximum length of a Java array.  The builder is<a name="line.187"></a>
<FONT color="green">188</FONT>             *  unmodified.<a name="line.188"></a>
<FONT color="green">189</FONT>             */<a name="line.189"></a>
<FONT color="green">190</FONT>            public void append(E[] newEs) {<a name="line.190"></a>
<FONT color="green">191</FONT>                append(newEs, 0, newEs.length);<a name="line.191"></a>
<FONT color="green">192</FONT>            }<a name="line.192"></a>
<FONT color="green">193</FONT>    <a name="line.193"></a>
<FONT color="green">194</FONT>            /** <a name="line.194"></a>
<FONT color="green">195</FONT>             * Appends a range of elements from a Java array to the Array<a name="line.195"></a>
<FONT color="green">196</FONT>             * @param newEs the source array<a name="line.196"></a>
<FONT color="green">197</FONT>             * @param off   the index of the first element to append<a name="line.197"></a>
<FONT color="green">198</FONT>             * @param len   the number of elements to append<a name="line.198"></a>
<FONT color="green">199</FONT>             * @throws ClassCastException if the &lt;code&gt;newEs&lt;/code&gt; is not powerless<a name="line.199"></a>
<FONT color="green">200</FONT>             * @throws IndexOutOfBoundsException if an out-of-bounds index would<a name="line.200"></a>
<FONT color="green">201</FONT>             *  be referenced or the resulting internal array would exceed the<a name="line.201"></a>
<FONT color="green">202</FONT>             *  maximum length of a Java array.  The builder is unmodified.<a name="line.202"></a>
<FONT color="green">203</FONT>             */<a name="line.203"></a>
<FONT color="green">204</FONT>            public void append(E[] newEs, int off, int len) {<a name="line.204"></a>
<FONT color="green">205</FONT>                final Class&lt;?&gt; e = newEs.getClass().getComponentType();<a name="line.205"></a>
<FONT color="green">206</FONT>                if (!JoeE.isSubtypeOf(e, Powerless.class)) {<a name="line.206"></a>
<FONT color="green">207</FONT>                    throw new ClassCastException(Reflection.getName(e) +<a name="line.207"></a>
<FONT color="green">208</FONT>                                                 " is not Powerless");<a name="line.208"></a>
<FONT color="green">209</FONT>                }<a name="line.209"></a>
<FONT color="green">210</FONT>                <a name="line.210"></a>
<FONT color="green">211</FONT>                appendInternal(newEs, off, len);<a name="line.211"></a>
<FONT color="green">212</FONT>            }<a name="line.212"></a>
<FONT color="green">213</FONT>            <a name="line.213"></a>
<FONT color="green">214</FONT>            /**<a name="line.214"></a>
<FONT color="green">215</FONT>             * Create a snapshot of the current content.<a name="line.215"></a>
<FONT color="green">216</FONT>             * @return a &lt;code&gt;PowerlesstArray&lt;E&gt;&lt;/code&gt; containing the elements so far<a name="line.216"></a>
<FONT color="green">217</FONT>             */<a name="line.217"></a>
<FONT color="green">218</FONT>            public PowerlessArray&lt;E&gt; snapshot() {<a name="line.218"></a>
<FONT color="green">219</FONT>                final Object[] arr;<a name="line.219"></a>
<FONT color="green">220</FONT>                if (size == buffer.length) {<a name="line.220"></a>
<FONT color="green">221</FONT>                    arr = buffer;<a name="line.221"></a>
<FONT color="green">222</FONT>                } else {<a name="line.222"></a>
<FONT color="green">223</FONT>                    arr = new Object[size];<a name="line.223"></a>
<FONT color="green">224</FONT>                    System.arraycopy(buffer, 0, arr, 0, size);<a name="line.224"></a>
<FONT color="green">225</FONT>                }<a name="line.225"></a>
<FONT color="green">226</FONT>                return new PowerlessArray&lt;E&gt;(arr);<a name="line.226"></a>
<FONT color="green">227</FONT>            }<a name="line.227"></a>
<FONT color="green">228</FONT>        } <a name="line.228"></a>
<FONT color="green">229</FONT>        <a name="line.229"></a>
<FONT color="green">230</FONT>        /**<a name="line.230"></a>
<FONT color="green">231</FONT>         * Get a &lt;code&gt;PowerlessArray.Builder&lt;/code&gt;.  This is equivalent to the<a name="line.231"></a>
<FONT color="green">232</FONT>         * constructor.<a name="line.232"></a>
<FONT color="green">233</FONT>         * @return a new builder instance, with the default internal array length<a name="line.233"></a>
<FONT color="green">234</FONT>         */<a name="line.234"></a>
<FONT color="green">235</FONT>        public static &lt;E&gt; Builder&lt;E&gt; builder() {<a name="line.235"></a>
<FONT color="green">236</FONT>            return new Builder&lt;E&gt;(0);<a name="line.236"></a>
<FONT color="green">237</FONT>        }<a name="line.237"></a>
<FONT color="green">238</FONT>        <a name="line.238"></a>
<FONT color="green">239</FONT>        /**<a name="line.239"></a>
<FONT color="green">240</FONT>         * Get a &lt;code&gt;PowerlessArray.Builder&lt;/code&gt;.  This is equivalent to the<a name="line.240"></a>
<FONT color="green">241</FONT>         * constructor.<a name="line.241"></a>
<FONT color="green">242</FONT>         * @param estimate  estimated array length  <a name="line.242"></a>
<FONT color="green">243</FONT>         * @return a new builder instance<a name="line.243"></a>
<FONT color="green">244</FONT>         */    <a name="line.244"></a>
<FONT color="green">245</FONT>        public static &lt;E&gt; Builder&lt;E&gt; builder(final int estimate) {<a name="line.245"></a>
<FONT color="green">246</FONT>            return new Builder&lt;E&gt;(estimate);<a name="line.246"></a>
<FONT color="green">247</FONT>        }<a name="line.247"></a>
<FONT color="green">248</FONT>    }<a name="line.248"></a>




























































</PRE>
</BODY>
</HTML>
